Tenant Administration API Calls

Get Tenant Metadata

This call returns all tenant metadata.

Authentication

This call requires Tenant Admin credentials

HTTP Method

GET

Request URI

api/v1/metadata/tenant

Example Request

https://[Ivanti Neurons for MDM]/api/v1/metadata/tenant

Response Fields

Field

Description

errors

 

result

 

  cmPermissionList

    app.create

 

    app.delete

 

    app.distribution.read

 

    app.distribution.update

 

    app.rating.read

 

    app.rating.update

 

    app.read

 

    app.review.delete

 

    app.review.read

 

    app.review.update

 

    app.update

 

    audit.app.read

 

    audit.content.read

 

    content.create

 

    content.delete

 

    content.distribution.read

 

    content.distribution.update

 

    content.read

 

    content.update

 

    vpp.code.read

 

    vpp.code.update

 

    vpp.license.delete

 

    vpp.license.read

 

    vpp.license.sync

 

    vpp.license.update

 

    vpp.order.create

 

    vpp.order.delete

 

    vpp.order.read

 

    vpp.order.update

 

    vpp.profile.create

 

    vpp.profile.read

 

  dmPermissionList

    app.inventory.read

 

    ca.create

 

    ca.delete

 

    ca.issued.certficiate.read

 

    ca.issued.certficiate.revoke

 

    ca.read

 

    ca.update

 

    device.create

 

    device.delete

 

    device.force.checkin

 

    device.locate

 

    device.lock

 

    device.push.profile

 

    device.read

 

    device.retire

 

    device.retire.cancel

 

    device.send.message

 

    device.start.mirroring

 

    device.stop.mirroring

 

    device.unlock

 

    device.update

 

    device.wipe

 

    device.wipe.cancel

 

    mdm.queue.delete

 

    mdm.queue.read

 

    policy.aim.audit.read

 

    policy.aim.create

 

    policy.aim.delete

 

    policy.aim.read

 

    policy.aim.to.ruleGroup.update

 

    policy.aim.update

 

    policy.air.play.audit.read

 

    policy.air.play.create

 

    policy.air.play.delete

 

    policy.air.play.read

 

    policy.air.play.to.ruleGroup.update

 

    policy.air.play.update

 

    policy.air.print.audit.read

 

    policy.air.print.create

 

    policy.air.print.delete

 

    policy.air.print.read

 

    policy.air.print.to.ruleGroup.update

 

    policy.air.print.update

 

    policy.android.encryption.audit.read

 

    policy.android.encryption.create

 

    policy.android.encryption.delete

 

    policy.android.encryption.read

 

    policy.android.encryption.to.ruleGroup.update

 

    policy.android.encryption.update

 

    policy.android.kiosk.audit.read

 

    policy.android.kiosk.create

 

    policy.android.kiosk.delete

 

    policy.android.kiosk.read

 

    policy.android.kiosk.to.ruleGroup.update

 

    policy.android.kiosk.update

 

    policy.android.lockdown.audit.read

 

    policy.android.lockdown.create

 

    policy.android.lockdown.delete

 

    policy.android.lockdown.read

 

    policy.android.lockdown.to.ruleGroup.update

 

    policy.android.lockdown.update

 

    policy.apn.audit.read

 

    policy.apn.create

 

    policy.apn.delete

 

    policy.apn.read

 

    policy.apn.to.ruleGroup.update

 

    policy.apn.update

 

    policy.app.lock.audit.read

 

    policy.app.lock.create

 

    policy.app.lock.delete

 

    policy.app.lock.read

 

    policy.app.lock.to.ruleGroup.update

 

    policy.app.lock.update

 

    policy.appconnect.app.config.audit.read

 

    policy.appconnect.app.config.create

 

    policy.appconnect.app.config.delete

 

    policy.appconnect.app.config.read

 

    policy.appconnect.app.config.to.ruleGroup.update

 

    policy.appconnect.app.config.update

 

    policy.appconnect.app.policy.audit.read

 

    policy.appconnect.app.policy.create

 

    policy.appconnect.app.policy.delete

 

    policy.appconnect.app.policy.read

 

    policy.appconnect.app.policy.to.ruleGroup.update

 

    policy.appconnect.app.policy.update

 

    policy.appconnect.zone.config.audit.read

 

    policy.appconnect.zone.config.create

 

    policy.appconnect.zone.config.delete

 

    policy.appconnect.zone.config.read

 

    policy.appconnect.zone.config.to.ruleGroup.update

 

    policy.appconnect.zone.config.update

 

    policy.application.access.audit.read

 

    policy.application.access.create

 

    policy.application.access.delete

 

    policy.application.access.read

 

    policy.application.access.to.ruleGroup.update

 

    policy.application.access.update

 

    policy.caldav.audit.read

 

    policy.caldav.create

 

    policy.caldav.delete

 

    policy.caldav.read

 

    policy.caldav.to.ruleGroup.update

 

    policy.caldav.update

 

    policy.carddav.audit.read

 

    policy.carddav.create

 

    policy.carddav.delete

 

    policy.carddav.read

 

    policy.carddav.to.ruleGroup.update

 

    policy.carddav.update

 

    policy.cellular.audit.read

 

    policy.cellular.create

 

    policy.cellular.delete

 

    policy.cellular.read

 

    policy.cellular.to.ruleGroup.update

 

    policy.cellular.update

 

    policy.certificate.audit.read

 

    policy.certificate.create

 

    policy.certificate.delete

 

    policy.certificate.read

 

    policy.certificate.store.create

 

    policy.certificate.store.delete

 

    policy.certificate.store.read

 

    policy.certificate.store.update

 

    policy.certificate.to.ruleGroup.update

 

    policy.certificate.update

 

    policy.device.registration.audit.read

 

    policy.device.registration.create

 

    policy.device.registration.delete

 

    policy.device.registration.read

 

    policy.device.registration.to.ruleGroup.update

 

    policy.device.registration.update

 

    policy.email.audit.read

 

    policy.email.create

 

    policy.email.delete

 

    policy.email.read

 

    policy.email.to.ruleGroup.update

 

    policy.email.update

 

    policy.exchange.audit.read

 

    policy.exchange.create

 

    policy.exchange.delete

 

    policy.exchange.read

 

    policy.exchange.to.ruleGroup.update

 

    policy.exchange.update

 

    policy.font.audit.read

 

    policy.font.create

 

    policy.font.delete

 

    policy.font.read

 

    policy.font.to.ruleGroup.update

 

    policy.font.update

 

    policy.general.ios.audit.read

 

    policy.general.ios.create

 

    policy.general.ios.delete

 

    policy.general.ios.read

 

    policy.general.ios.to.ruleGroup.update

 

    policy.general.ios.update

 

    policy.global.proxy.audit.read

 

    policy.global.proxy.create

 

    policy.global.proxy.delete

 

    policy.global.proxy.read

 

    policy.global.proxy.to.ruleGroup.update

 

    policy.global.proxy.update

 

    policy.identity.certificate.dg.audit.read

 

    policy.identity.certificate.dg.create

 

    policy.identity.certificate.dg.delete

 

    policy.identity.certificate.dg.read

 

    policy.identity.certificate.dg.to.ruleGroup.update

 

    policy.identity.certificate.dg.update

 

    policy.identityCertificate.audit.read

 

    policy.identityCertificate.create

 

    policy.identityCertificate.delete

 

    policy.identityCertificate.read

 

    policy.identityCertificate.to.ruleGroup.update

 

    policy.identityCertificate.update

 

    policy.jabber.audit.read

 

    policy.jabber.create

 

    policy.jabber.delete

 

    policy.jabber.read

 

    policy.jabber.to.ruleGroup.update

 

    policy.jabber.update

 

    policy.ldap.audit.read

 

    policy.ldap.create

 

    policy.ldap.delete

 

    policy.ldap.read

 

    policy.ldap.to.ruleGroup.update

 

    policy.ldap.update

 

    policy.localCa.audit.read

 

    policy.localCa.create

 

    policy.localCa.delete

 

    policy.localCa.read

 

    policy.localCa.to.ruleGroup.update

 

    policy.localCa.update

 

    policy.mdm.audit.read

 

    policy.mdm.create

 

    policy.mdm.delete

 

    policy.mdm.read

 

    policy.mdm.to.ruleGroup.update

 

    policy.mdm.update

 

    policy.opaque.ios.audit.read

 

    policy.opaque.ios.create

 

    policy.opaque.ios.delete

 

    policy.opaque.ios.read

 

    policy.opaque.ios.to.ruleGroup.update

 

    policy.opaque.ios.update

 

    policy.org.info.setting.audit.read

 

    policy.org.info.setting.create

 

    policy.org.info.setting.delete

 

    policy.org.info.setting.read

 

    policy.org.info.setting.to.rule.group.update

 

    policy.org.info.setting.update

 

    policy.osx.restrictions.audit.read

 

    policy.osx.restrictions.create

 

    policy.osx.restrictions.delete

 

    policy.osx.restrictions.read

 

    policy.osx.restrictions.to.ruleGroup.update

 

    policy.osx.restrictions.update

 

    policy.passcode.audit.read

 

    policy.passcode.create

 

    policy.passcode.delete

 

    policy.passcode.read

 

    policy.passcode.to.ruleGroup.update

 

    policy.passcode.update

 

    policy.policy.audit.read

 

    policy.policy.create

 

    policy.policy.delete

 

    policy.policy.read

 

    policy.policy.to.ruleGroup.update

 

    policy.policy.update

 

    policy.privacy.audit.read

 

    policy.privacy.create

 

    policy.privacy.delete

 

    policy.privacy.read

 

    policy.privacy.to.ruleGroup.update

 

    policy.privacy.update

 

    policy.provisioningProfile.audit.read

 

    policy.provisioningProfile.create

 

    policy.provisioningProfile.delete

 

    policy.provisioningProfile.read

 

    policy.provisioningProfile.to.ruleGroup.update

 

    policy.provisioningProfile.update

 

    policy.read

 

    policy.restrictions.audit.read

 

    policy.restrictions.create

 

    policy.restrictions.delete

 

    policy.restrictions.read

 

    policy.restrictions.to.ruleGroup.update

 

    policy.restrictions.update

 

    policy.scep.audit.read

 

    policy.scep.create

 

    policy.scep.delete

 

    policy.scep.read

 

    policy.scep.to.ruleGroup.update

 

    policy.scep.update

 

    policy.sharepoint.audit.read

 

    policy.sharepoint.create

 

    policy.sharepoint.delete

 

    policy.sharepoint.read

 

    policy.sharepoint.to.ruleGroup.update

 

    policy.sharepoint.update

 

    policy.sso.account.audit.read

 

    policy.sso.account.create

 

    policy.sso.account.delete

 

    policy.sso.account.read

 

    policy.sso.account.to.ruleGroup.update

 

    policy.sso.account.update

 

    policy.subscribedCalendar.audit.read

 

    policy.subscribedCalendar.create

 

    policy.subscribedCalendar.delete

 

    policy.subscribedCalendar.read

 

    policy.subscribedCalendar.to.ruleGroup.update

 

    policy.subscribedCalendar.update

 

    policy.sync.audit.read

 

    policy.sync.create

 

    policy.sync.delete

 

    policy.sync.read

 

    policy.sync.to.ruleGroup.update

 

    policy.sync.update

 

    policy.telecom.settings.audit.read

 

    policy.telecom.settings.create

 

    policy.telecom.settings.delete

 

    policy.telecom.settings.read

 

    policy.telecom.settings.to.ruleGroup.update

 

    policy.telecom.settings.update

 

    policy.user.interface.settings.audit.read

 

    policy.user.interface.settings.create

 

    policy.user.interface.settings.delete

 

    policy.user.interface.settings.read

 

    policy.user.interface.settings.to.ruleGroup.update

 

    policy.user.interface.settings.update

 

    policy.vpn.audit.read

 

    policy.vpn.create

 

    policy.vpn.delete

 

    policy.vpn.ondemand.audit.read

 

    policy.vpn.ondemand.create

 

    policy.vpn.ondemand.delete

 

    policy.vpn.ondemand.read

 

    policy.vpn.ondemand.to.ruleGroup.update

 

    policy.vpn.ondemand.update

 

    policy.vpn.per.app.audit.read

 

    policy.vpn.per.app.create

 

    policy.vpn.per.app.delete

 

    policy.vpn.per.app.read

 

    policy.vpn.per.app.to.ruleGroup.update

 

    policy.vpn.per.app.update

 

    policy.vpn.read

 

    policy.vpn.to.ruleGroup.update

 

    policy.vpn.update

 

    policy.web.content.filter.audit.read

 

    policy.web.content.filter.create

 

    policy.web.content.filter.delete

 

    policy.web.content.filter.read

 

    policy.web.content.filter.to.ruleGroup.update

 

    policy.web.content.filter.update

 

    policy.webclip.audit.read

 

    policy.webclip.create

 

    policy.webclip.delete

 

    policy.webclip.read

 

    policy.webclip.to.ruleGroup.update

 

    policy.webclip.update

 

    policy.wifi.audit.read

 

    policy.wifi.create

 

    policy.wifi.delete

 

    policy.wifi.read

 

    policy.wifi.to.ruleGroup.update

 

    policy.wifi.update

 

    ruleGroup.create

 

    ruleGroup.delete

 

    ruleGroup.read

 

    ruleGroup.update

 

  tenantPermissionList

    account.create

 

    account.delete

 

    account.generate.pin

 

    account.invite.admin

 

    account.invite.enduser

 

    account.password.change

 

    account.password.reset

 

    account.permission.tenant.read

 

    account.preferences.change

 

    account.read

 

    account.send.message

 

    account.to.group.update

 

    account.to.role.update

 

    account.update

 

    accountGroup.create

 

    accountGroup.delete

 

    accountGroup.read

 

    accountGroup.to.account.update

 

    accountGroup.to.group.update

 

    accountGroup.to.role.update

 

    accountGroup.update

 

    accountRole.create

 

    accountRole.delete

 

    accountRole.read

 

    accountRole.to.account.update

 

    accountRole.to.group.update

 

    accountRole.to.permission.update

 

    accountRole.update

 

    alcor.create

 

    alcor.delete

 

    alcor.read

 

    alcor.update

 

    app.category.create

 

    app.category.delete

 

    app.category.read

 

    app.category.update

 

    app.search.googleplay

 

    app.search.itunes

 

    app.store.settings.read

 

    app.store.settings.update

 

    appstore.preview

 

    audit.account.read

 

    audit.accountGroup.read

 

    configurator.authtoken.create

 

    configurator.authtoken.delete

 

    configurator.authtoken.read

 

    configurator.plist.read

 

    content.category.create

 

    content.category.delete

 

    content.category.read

 

    content.category.update

 

    contentstore.preview

 

    device.register

 

    eula.tenant.accept

 

    eula.tenant.read

 

    ios.dep.device.disown

 

    ios.dep.profile.create

 

    ios.dep.profile.delete

 

    ios.dep.profile.read

 

    ios.dep.profile.update

 

    ios.dep.virtual.server.create

 

    ios.dep.virtual.server.delete

 

    ios.dep.virtual.server.read

 

    ios.dep.virtual.server.update

 

    kocab.create

 

    kocab.delete

 

    kocab.read

 

    kocab.update

 

    ldap.authenticate.user

 

    ldap.persist.group

 

    ldap.persist.organizationalUnit

 

    ldap.persist.user

 

    ldap.search.generic

 

    ldap.search.group

 

    ldap.search.organizationalUnit

 

    ldap.search.user

 

    ldap.server.create

 

    ldap.server.decouple.generic

 

    ldap.server.default.read

 

    ldap.server.delete

 

    ldap.server.persist.generic

 

    ldap.server.read

 

    ldap.server.sync

 

    ldap.server.test.connection

 

    ldap.server.update

 

    mdm.push.certificate.read

 

    mdm.push.certificate.update

 

    mdm.push.certificate.validate

 

    mdm.push.identity.export

 

    mdm.push.identity.update

 

    mdm.push.keypair.update

 

    mdm.push.plist.read

 

    mdm.status.update

 

    message.create

 

    message.delete

 

    message.read

 

    message.update

 

    mizar.create

 

    mizar.delete

 

    mizar.read

 

    mizar.update

 

    open.sfdc.support.case

 

    partition.content.create

 

    partition.content.read

 

    partition.content.update

 

    partition.device.create

 

    partition.device.delete

 

    partition.device.read

 

    partition.device.update

 

    policy.certificate.store.read.all

 

    policy.template.tenant.read

 

    report.metadata.read

 

    report.snapshot.read

 

    report.trending.read

 

    sfdc.oauth.profile.read

 

    sfdc.oauth.profile.update

 

    tenant.settings.read

 

    tenant.settings.update

 

    user.policy.device.limit.audit.read

 

    user.policy.device.limit.create

 

    user.policy.device.limit.delete

 

    user.policy.device.limit.read

 

    user.policy.device.limit.to.userGroup.update

 

    user.policy.device.limit.update

 

    user.policy.read

 

    user.policy.registration.auth.audit.read

 

    user.policy.registration.auth.create

 

    user.policy.registration.auth.delete

 

    user.policy.registration.auth.read

 

    user.policy.registration.auth.to.userGroup.update

 

    user.policy.registration.auth.update

 

    user.policy.terms.of.service.audit.read

 

    user.policy.terms.of.service.create

 

    user.policy.terms.of.service.delete

 

    user.policy.terms.of.service.read

 

    user.policy.terms.of.service.to.userGroup.update

 

    user.policy.terms.of.service.update

 

    utils.x509.fingerprint.read

 

    whitelabel.resource.tenant.read

 

    totalContentAllowed

How many content artifacts the tenant can store.

    maximumContentFileSize

 

    totalDevicePartitionsAllowed

 

  cobrandingFooter

 

  whiteLabelKey

 

  whiteLabelProductName

 

  knowledgeBaseUrl

 

  supportTicketEnabled

 

    branch

 

    revision

 

    version

 

  connectorISOPath

 

  tenantGuid

 

  nobodyAccountId

 

  defaultDmPartitionId

 

  defaultCmPartitionId

 

  tenantSetupRequired

 

  eulaRequired

 

  welcomeVideoId

 

Example Response

{

    "errors": null,

    "result": {

        "cmPermissionList": [

            "app.create",

            "app.delete",

            "app.distribution.read",

            "app.distribution.update",

            "app.rating.read",

            "app.rating.update",

            "app.read",

            "app.review.delete",

            "app.review.read",

            "app.review.update",

            "app.update",

            "audit.app.read",

            "audit.content.read",

            "content.create",

            "content.delete",

            "content.distribution.read",

            "content.distribution.update",

            "content.read",

            "content.update",

            "vpp.code.read",

            "vpp.code.update",

            "vpp.license.delete",

            "vpp.license.read",

            "vpp.license.sync",

            "vpp.license.update",

            "vpp.order.create",

            "vpp.order.delete",

            "vpp.order.read",

            "vpp.order.update",

            "vpp.profile.create",

            "vpp.profile.read"

        ],

        "dmPermissionList": [

            "app.inventory.read",

            "ca.create",

            "ca.delete",

            "ca.issued.certficiate.read",

            "ca.issued.certficiate.revoke",

            "ca.read",

            "ca.update",

            "device.create",

            "device.delete",

            "device.exit.kiosk.mode",

            "device.force.checkin",

            "device.locate",

            "device.lock",

            "device.push.profile",

            "device.read",

            "device.retire",

            "device.retire.cancel",

            "device.send.message",

            "device.start.mirroring",

            "device.stop.mirroring",

            "device.unlock",

            "device.update",

            "device.wipe",

            "device.wipe.cancel",

            "mdm.queue.delete",

            "mdm.queue.read",

            "policy.aim.audit.read",

            "policy.aim.create",

            "policy.aim.delete",

            "policy.aim.read",

            "policy.aim.to.ruleGroup.update",

            "policy.aim.update",

            "policy.air.play.audit.read",

            "policy.air.play.create",

            "policy.air.play.delete",

            "policy.air.play.read",

            "policy.air.play.to.ruleGroup.update",

            "policy.air.play.update",

            "policy.air.print.audit.read",

            "policy.air.print.create",

            "policy.air.print.delete",

            "policy.air.print.read",

            "policy.air.print.to.ruleGroup.update",

            "policy.air.print.update",

            "policy.android.appcatalog.audit.read",

            "policy.android.appcatalog.create",

            "policy.android.appcatalog.delete",

            "policy.android.appcatalog.read",

            "policy.android.appcatalog.to.ruleGroup.update",

            "policy.android.appcatalog.update",

            "policy.android.encryption.audit.read",

            "policy.android.encryption.create",

            "policy.android.encryption.delete",

            "policy.android.encryption.read",

            "policy.android.encryption.to.ruleGroup.update",

            "policy.android.encryption.update",

            "policy.android.kiosk.audit.read",

            "policy.android.kiosk.create",

            "policy.android.kiosk.delete",

            "policy.android.kiosk.read",

            "policy.android.kiosk.to.ruleGroup.update",

            "policy.android.kiosk.update",

            "policy.android.lockdown.audit.read",

            "policy.android.lockdown.create",

            "policy.android.lockdown.delete",

            "policy.android.lockdown.read",

            "policy.android.lockdown.to.ruleGroup.update",

            "policy.android.lockdown.update",

            "policy.apn.audit.read",

            "policy.apn.create",

            "policy.apn.delete",

            "policy.apn.read",

            "policy.apn.to.ruleGroup.update",

            "policy.apn.update",

            "policy.app.lock.audit.read",

            "policy.app.lock.create",

            "policy.app.lock.delete",

            "policy.app.lock.read",

            "policy.app.lock.to.ruleGroup.update",

            "policy.app.lock.update",

            "policy.appconnect.app.config.audit.read",

            "policy.appconnect.app.config.create",

            "policy.appconnect.app.config.delete",

            "policy.appconnect.app.config.read",

            "policy.appconnect.app.config.to.ruleGroup.update",

            "policy.appconnect.app.config.update",

            "policy.appconnect.app.policy.audit.read",

            "policy.appconnect.app.policy.create",

            "policy.appconnect.app.policy.delete",

            "policy.appconnect.app.policy.read",

            "policy.appconnect.app.policy.to.ruleGroup.update",

            "policy.appconnect.app.policy.update",

            "policy.appconnect.zone.config.audit.read",

            "policy.appconnect.zone.config.create",

            "policy.appconnect.zone.config.delete",

            "policy.appconnect.zone.config.read",

            "policy.appconnect.zone.config.to.ruleGroup.update",

            "policy.appconnect.zone.config.update",

            "policy.application.access.audit.read",

            "policy.application.access.create",

            "policy.application.access.delete",

            "policy.application.access.read",

            "policy.application.access.to.ruleGroup.update",

            "policy.application.access.update",

            "policy.caldav.audit.read",

            "policy.caldav.create",

            "policy.caldav.delete",

            "policy.caldav.read",

            "policy.caldav.to.ruleGroup.update",

            "policy.caldav.update",

            "policy.carddav.audit.read",

            "policy.carddav.create",

            "policy.carddav.delete",

            "policy.carddav.read",

            "policy.carddav.to.ruleGroup.update",

            "policy.carddav.update",

            "policy.cellular.audit.read",

            "policy.cellular.create",

            "policy.cellular.delete",

            "policy.cellular.read",

            "policy.cellular.to.ruleGroup.update",

            "policy.cellular.update",

            "policy.certificate.audit.read",

            "policy.certificate.create",

            "policy.certificate.delete",

            "policy.certificate.read",

            "policy.certificate.store.create",

            "policy.certificate.store.delete",

            "policy.certificate.store.read",

            "policy.certificate.store.update",

            "policy.certificate.to.ruleGroup.update",

            "policy.certificate.update",

            "policy.device.registration.audit.read",

            "policy.device.registration.create",

            "policy.device.registration.delete",

            "policy.device.registration.read",

            "policy.device.registration.to.ruleGroup.update",

            "policy.device.registration.update",

            "policy.email.audit.read",

            "policy.email.create",

            "policy.email.delete",

            "policy.email.read",

            "policy.email.to.ruleGroup.update",

            "policy.email.update",

            "policy.exchange.audit.read",

            "policy.exchange.create",

            "policy.exchange.delete",

            "policy.exchange.read",

            "policy.exchange.to.ruleGroup.update",

            "policy.exchange.update",

            "policy.font.audit.read",

            "policy.font.create",

            "policy.font.delete",

            "policy.font.read",

            "policy.font.to.ruleGroup.update",

            "policy.font.update",

            "policy.general.ios.audit.read",

            "policy.general.ios.create",

            "policy.general.ios.delete",

            "policy.general.ios.read",

            "policy.general.ios.to.ruleGroup.update",

            "policy.general.ios.update",

            "policy.global.proxy.audit.read",

            "policy.global.proxy.create",

            "policy.global.proxy.delete",

            "policy.global.proxy.read",

            "policy.global.proxy.to.ruleGroup.update",

            "policy.global.proxy.update",

            "policy.identity.certificate.dg.audit.read",

            "policy.identity.certificate.dg.create",

            "policy.identity.certificate.dg.delete",

            "policy.identity.certificate.dg.read",

            "policy.identity.certificate.dg.to.ruleGroup.update",

            "policy.identity.certificate.dg.update",

            "policy.identityCertificate.audit.read",

            "policy.identityCertificate.create",

            "policy.identityCertificate.delete",

            "policy.identityCertificate.read",

            "policy.identityCertificate.to.ruleGroup.update",

            "policy.identityCertificate.update",

            "policy.jabber.audit.read",

            "policy.jabber.create",

            "policy.jabber.delete",

            "policy.jabber.read",

            "policy.jabber.to.ruleGroup.update",

            "policy.jabber.update",

            "policy.ldap.audit.read",

            "policy.ldap.create",

            "policy.ldap.delete",

            "policy.ldap.read",

            "policy.ldap.to.ruleGroup.update",

            "policy.ldap.update",

            "policy.localCa.audit.read",

            "policy.localCa.create",

            "policy.localCa.delete",

            "policy.localCa.read",

            "policy.localCa.to.ruleGroup.update",

            "policy.localCa.update",

            "policy.mdm.audit.read",

            "policy.mdm.create",

            "policy.mdm.delete",

            "policy.mdm.read",

            "policy.mdm.to.ruleGroup.update",

            "policy.mdm.update",

            "policy.opaque.ios.audit.read",

            "policy.opaque.ios.create",

            "policy.opaque.ios.delete",

            "policy.opaque.ios.read",

            "policy.opaque.ios.to.ruleGroup.update",

            "policy.opaque.ios.update",

            "policy.org.info.setting.audit.read",

            "policy.org.info.setting.create",

            "policy.org.info.setting.delete",

            "policy.org.info.setting.read",

            "policy.org.info.setting.to.rule.group.update",

            "policy.org.info.setting.update",

            "policy.osx.restrictions.audit.read",

            "policy.osx.restrictions.create",

            "policy.osx.restrictions.delete",

            "policy.osx.restrictions.read",

            "policy.osx.restrictions.to.ruleGroup.update",

            "policy.osx.restrictions.update",

            "policy.passcode.audit.read",

            "policy.passcode.create",

            "policy.passcode.delete",

            "policy.passcode.read",

            "policy.passcode.to.ruleGroup.update",

            "policy.passcode.update",

            "policy.policy.audit.read",

            "policy.policy.create",

            "policy.policy.delete",

            "policy.policy.read",

            "policy.policy.to.ruleGroup.update",

            "policy.policy.update",

            "policy.privacy.audit.read",

            "policy.privacy.create",

            "policy.privacy.delete",

            "policy.privacy.read",

            "policy.privacy.to.ruleGroup.update",

            "policy.privacy.update",

            "policy.provisioningProfile.audit.read",

            "policy.provisioningProfile.create",

            "policy.provisioningProfile.delete",

            "policy.provisioningProfile.read",

            "policy.provisioningProfile.to.ruleGroup.update",

            "policy.provisioningProfile.update",

            "policy.read",

            "policy.restrictions.audit.read",

            "policy.restrictions.create",

            "policy.restrictions.delete",

            "policy.restrictions.read",

            "policy.restrictions.to.ruleGroup.update",

            "policy.restrictions.update",

            "policy.scep.audit.read",

            "policy.scep.create",

            "policy.scep.delete",

            "policy.scep.read",

            "policy.scep.to.ruleGroup.update",

            "policy.scep.update",

            "policy.serviceConnect.audit.read",

            "policy.serviceConnect.create",

            "policy.serviceConnect.delete",

            "policy.serviceConnect.read",

            "policy.serviceConnect.to.ruleGroup.update",

            "policy.serviceConnect.update",

            "policy.sharepoint.audit.read",

            "policy.sharepoint.create",

            "policy.sharepoint.delete",

            "policy.sharepoint.read",

            "policy.sharepoint.to.ruleGroup.update",

            "policy.sharepoint.update",

            "policy.sso.account.audit.read",

            "policy.sso.account.create",

            "policy.sso.account.delete",

            "policy.sso.account.read",

            "policy.sso.account.to.ruleGroup.update",

            "policy.sso.account.update",

            "policy.subscribedCalendar.audit.read",

            "policy.subscribedCalendar.create",

            "policy.subscribedCalendar.delete",

            "policy.subscribedCalendar.read",

            "policy.subscribedCalendar.to.ruleGroup.update",

            "policy.subscribedCalendar.update",

            "policy.sync.audit.read",

            "policy.sync.create",

            "policy.sync.delete",

            "policy.sync.read",

            "policy.sync.to.ruleGroup.update",

            "policy.sync.update",

            "policy.telecom.settings.audit.read",

            "policy.telecom.settings.create",

            "policy.telecom.settings.delete",

            "policy.telecom.settings.read",

            "policy.telecom.settings.to.ruleGroup.update",

            "policy.telecom.settings.update",

            "policy.user.interface.settings.audit.read",

            "policy.user.interface.settings.create",

            "policy.user.interface.settings.delete",

            "policy.user.interface.settings.read",

            "policy.user.interface.settings.to.ruleGroup.update",

            "policy.user.interface.settings.update",

            "policy.vpn.audit.read",

            "policy.vpn.create",

            "policy.vpn.delete",

            "policy.vpn.ondemand.audit.read",

            "policy.vpn.ondemand.create",

            "policy.vpn.ondemand.delete",

            "policy.vpn.ondemand.read",

            "policy.vpn.ondemand.to.ruleGroup.update",

            "policy.vpn.ondemand.update",

            "policy.vpn.per.app.audit.read",

            "policy.vpn.per.app.create",

            "policy.vpn.per.app.delete",

            "policy.vpn.per.app.read",

            "policy.vpn.per.app.to.ruleGroup.update",

            "policy.vpn.per.app.update",

            "policy.vpn.read",

            "policy.vpn.to.ruleGroup.update",

            "policy.vpn.update",

            "policy.wallpaper.settings.audit.read",

            "policy.wallpaper.settings.create",

            "policy.wallpaper.settings.delete",

            "policy.wallpaper.settings.read",

            "policy.wallpaper.settings.to.ruleGroup.update",

            "policy.wallpaper.settings.update",

            "policy.web.content.filter.audit.read",

            "policy.web.content.filter.create",

            "policy.web.content.filter.delete",

            "policy.web.content.filter.read",

            "policy.web.content.filter.to.ruleGroup.update",

            "policy.web.content.filter.update",

            "policy.webclip.audit.read",

            "policy.webclip.create",

            "policy.webclip.delete",

            "policy.webclip.read",

            "policy.webclip.to.ruleGroup.update",

            "policy.webclip.update",

            "policy.wifi.audit.read",

            "policy.wifi.create",

            "policy.wifi.delete",

            "policy.wifi.read",

            "policy.wifi.to.ruleGroup.update",

            "policy.wifi.update",

            "ruleGroup.create",

            "ruleGroup.delete",

            "ruleGroup.read",

            "ruleGroup.update"

        ],

        "tenantPermissionList": [

            "account.create",

            "account.delete",

            "account.generate.pin",

            "account.invite.admin",

            "account.invite.enduser",

            "account.password.change",

            "account.password.reset",

            "account.permission.tenant.read",

            "account.preferences.change",

            "account.read",

            "account.send.message",

            "account.to.group.update",

            "account.to.role.update",

            "account.update",

            "accountGroup.create",

            "accountGroup.delete",

            "accountGroup.read",

            "accountGroup.to.account.update",

            "accountGroup.to.group.update",

            "accountGroup.to.role.update",

            "accountGroup.update",

            "accountRole.create",

            "accountRole.delete",

            "accountRole.read",

            "accountRole.to.account.update",

            "accountRole.to.group.update",

            "accountRole.to.permission.update",

            "accountRole.update",

            "alcor.configuration.create",

            "alcor.configuration.delete",

            "alcor.configuration.read",

            "alcor.configuration.update",

            "alcor.create",

            "alcor.delete",

            "alcor.read",

            "alcor.tunnel.delete",

            "alcor.tunnel.read",

            "alcor.tunnel.update.action",

            "alcor.update",

            "api.connection.profile.create",

            "api.connection.profile.delete",

            "api.connection.profile.read",

            "api.connection.profile.update",

            "app.category.create",

            "app.category.delete",

            "app.category.read",

            "app.category.update",

            "app.search.googleplay",

            "app.search.itunes",

            "app.store.settings.read",

            "app.store.settings.update",

            "appstore.preview",

            "audit.account.read",

            "audit.accountGroup.read",

            "configurator.authtoken.create",

            "configurator.authtoken.delete",

            "configurator.authtoken.read",

            "configurator.plist.read",

            "content.category.create",

            "content.category.delete",

            "content.category.read",

            "content.category.update",

            "contentstore.preview",

            "device.register",

            "enduser.account.generate.pin",

            "enduser.account.read",

            "enduser.account.update",

            "enduser.device.checkin",

            "enduser.device.lock",

            "enduser.device.read",

            "enduser.device.retire",

            "enduser.device.unlock",

            "enduser.device.wipe",

            "eula.tenant.accept",

            "eula.tenant.read",

            "ios.dep.device.disown",

            "ios.dep.profile.create",

            "ios.dep.profile.delete",

            "ios.dep.profile.read",

            "ios.dep.profile.update",

            "ios.dep.virtual.server.create",

            "ios.dep.virtual.server.delete",

            "ios.dep.virtual.server.read",

            "ios.dep.virtual.server.update",

            "kocab.create",

            "kocab.delete",

            "kocab.read",

            "kocab.update",

            "ldap.authenticate.user",

            "ldap.persist.group",

            "ldap.persist.organizationalUnit",

            "ldap.persist.user",

            "ldap.search.generic",

            "ldap.search.group",

            "ldap.search.organizationalUnit",

            "ldap.search.user",

            "ldap.server.create",

            "ldap.server.decouple.generic",

            "ldap.server.default.read",

            "ldap.server.delete",

            "ldap.server.persist.generic",

            "ldap.server.read",

            "ldap.server.sync",

            "ldap.server.test.connection",

            "ldap.server.update",

            "mdm.push.certificate.read",

            "mdm.push.certificate.update",

            "mdm.push.certificate.validate",

            "mdm.push.identity.export",

            "mdm.push.identity.update",

            "mdm.push.keypair.update",

            "mdm.push.plist.read",

            "mdm.status.update",

            "message.create",

            "message.delete",

            "message.read",

            "message.update",

            "mizar.create",

            "mizar.delete",

            "mizar.read",

            "mizar.update",

            "open.sfdc.support.case",

            "partition.content.create",

            "partition.content.read",

            "partition.content.update",

            "partition.device.create",

            "partition.device.delete",

            "partition.device.read",

            "partition.device.update",

            "policy.certificate.store.read.all",

            "policy.template.tenant.read",

            "report.metadata.read",

            "report.snapshot.read",

            "report.trending.read",

            "sfdc.oauth.profile.read",

            "sfdc.oauth.profile.update",

            "tenant.settings.read",

            "tenant.settings.update",

            "user.policy.device.limit.audit.read",

            "user.policy.device.limit.create",

            "user.policy.device.limit.delete",

            "user.policy.device.limit.read",

            "user.policy.device.limit.to.userGroup.update",

            "user.policy.device.limit.update",

            "user.policy.googleApps.audit.read",

            "user.policy.googleApps.create",

            "user.policy.googleApps.delete",

            "user.policy.googleApps.read",

            "user.policy.googleApps.to.userGroup.update",

            "user.policy.googleApps.update",

            "user.policy.read",

            "user.policy.registration.auth.audit.read",

            "user.policy.registration.auth.create",

            "user.policy.registration.auth.delete",

            "user.policy.registration.auth.read",

            "user.policy.registration.auth.to.userGroup.update",

            "user.policy.registration.auth.update",

            "user.policy.terms.of.service.audit.read",

            "user.policy.terms.of.service.create",

            "user.policy.terms.of.service.delete",

            "user.policy.terms.of.service.read",

            "user.policy.terms.of.service.to.userGroup.update",

            "user.policy.terms.of.service.update",

            "utils.x509.fingerprint.read",

            "whitelabel.resource.tenant.read"

        ],

        "licenseRestrictions": {

            "totalContentAllowed": 25,

            "maximumContentFileSize": 2000000,

            "totalDevicePartitionsAllowed": 5

        },

        "cobrandingFooter": false,

        "whiteLabelKey": "mobileiron",

        "whiteLabelProductName": "Cloud",

        "knowledgeBaseUrl": null,

        "supportTicketEnabled": true,

        "webAppVersion": {

            "branch": "origin/master",

            "revision": "9e99b6ad3f7de2a7e988ab8a0d688e09392a5343",

            "version": "2.7.0.605"

        },

        "connectorISOPath": "https://support.mobileiron.com/cloud-connector/current/connector-LATEST.zip",

        "alcorISOPath": "https://support.mobileiron.com/cloud-sentry/current/sentry-cloud-LATEST.iso",

        "tenantGuid": "df2eec7e-a349-4e72-ac03-4aafdc7b2856",

        "nobodyAccountId": 10000,

        "defaultDmPartitionId": 23000,

        "defaultCmPartitionId": 20000,

        "tenantSetupRequired": false,

        "eulaRequired": true,

        "welcomeVideoId": "WaeYg5dVveA"

    }

}

 

Get Device Spaces

This call lists all device spaces in the current tenant.

Authentication

This call requires Tenant Admin credentials

HTTP Method

GET

Request URI

/api/v1/tenant/partition/device

Example Request

https://[Ivanti Neurons for MDM]/api/v1/tenant/partition/device

Response Fields

Field

Description

errors

Indicates whether there were errors.

result

Container for retrieved results.

    totalCount

Describes how many rows were found.

    queryTime

Describes how long the query took to execute.

    searchResults

Container for results details.

            id

Space ID.

            createdAt

When created.

            createdBy

Who created it.

            modifiedAt

When modified.

            modifiedBy

Who modified it.

            name

Name of the space.

            description

Description of the space.

            domainRule

 

            defaultPartition

Indicates whether this is the default space. 1 for yes, 0 for no.

            priority

 

            treeView

 

            deviceCount

Indicates how many devices are assigned to this space.

            configurationCount

 

            policyCount

Lists how may policies apply to this space.

            deviceGroupCount

Lists how may device groups are assigned to this space.

    offset

Lists the offset in retrieved rows.

    limit

Lists how many rows to which the query is limited.

Example Response

{

    "errors": null,

    "result": {

        "totalCount": 1,

        "queryTime": 0,

        "searchResults": [

            {

                "id": 23000,

                "createdAt": 1415047963288,

                "createdBy": 1,

                "modifiedAt": 1415047963288,

                "modifiedBy": null,

                "name": "Default Partition",

                "description": "Default device management partition.",

                "domainRule": null,

                "defaultPartition": true,

                "priority": 1,

                "treeView": null,

                "deviceCount": 0,

                "configurationCount": 13,

                "policyCount": 4,

                "deviceGroupCount": 4

            }

        ],

        "offset": 0,

        "limit": 50

    }

}

Get current license information

This call returns current tenant license information.

Authentication

This call requires Tenant Admin credentials

HTTP Method

GET

Request URI

/api/v1/tenant/license/usage

Request Parameters

Parameter

Argument Type

Description

Example Value

requestedFields

requestBody

Request terms

accountTerm, contentTerm, upgradeInfo, licenseTerm

Example cURL with No Request field (Default / Current behaviour)

curl --location --request GET 'https://[Ivanti Neurons for MDM]/api/v1/tenant/license/usage' \

--header 'Accept: application/json, text/plain,/'\

--header 'Content-Type: application/json' \

--header 'Authorization: Basic <token>'

Example Response

{
    "errors": null,
    "result": {
        "billingType": "SUBSCRIPTION",
        "licenseSkus": [
            "PLATINUM"
        ],
        "displayName": "Platinum",
        "licenseType": "DEVICE",
        "perSeatDenominator": 1,
        "licenseStatus": "ACTIVATED",
        "startDate": 1714975231998,
        "durationInDays": 365,
        "upgradeRequestAt": null,
        "licenseTerm": {
            "softLimit": 1000,
            "hardLimit": 0,
            "currentUsage": 1
        },
        "accountTerm": {
            "softLimit": 0,
            "hardLimit": 0,
            "currentUsage": 248
        },
        "contentTerm": {
            "softLimit": 0,
            "hardLimit": 50,
            "currentUsage": 0
        },
        "activeDeviceCount": 1,
        "trial": true
    }
}

Example cURL with Single Request field

curl --location --request GET 'https://[Ivanti Neurons for MDM]/api/v1/tenant/license/usage?requestedFields=licenseTerm' \

--header 'Accept: application/json, text/plain,/'\

--header 'Content-Type: application/json' \

--header 'Authorization: Basic <token>'

Example Response

{
    "errors": null,
    "result": {
        "billingType": "SUBSCRIPTION",
        "licenseSkus": [
            "PLATINUM"
        ],
        "displayName": "Platinum",
        "licenseType": "DEVICE",
        "perSeatDenominator": 1,
        "licenseStatus": "ACTIVATED",
        "startDate": 1714975231998,
        "durationInDays": 365,
        "upgradeRequestAt": null,
        "licenseTerm": {
            "softLimit": 1000,
            "hardLimit": 0,
            "currentUsage": 1
        },
        "accountTerm": null,
        "contentTerm": null,
        "activeDeviceCount": 1,
        "trial": true
    }
}

Example cURL with Multiple Request fields

curl --location --request GET 'https://[Ivanti Neurons for MDM]/api/v1/tenant/license/usage?requestedFields=licenseTerm%2CaccountTerm' \

--header 'Accept: application/json, text/plain,/'\

--header 'Content-Type: application/json' \

--header 'Authorization: Basic <token>'

Example Response

{
    "errors": null,
    "result": {
        "billingType": "SUBSCRIPTION",
        "licenseSkus": [
            "PLATINUM"
        ],
        "displayName": "Platinum",
        "licenseType": "DEVICE",
        "perSeatDenominator": 1,
        "licenseStatus": "ACTIVATED",
        "startDate": 1714975231998,
        "durationInDays": 365,
        "upgradeRequestAt": null,
        "licenseTerm": {
            "softLimit": 1000,
            "hardLimit": 0,
            "currentUsage": 1
        },
        "accountTerm": {
            "softLimit": 0,
            "hardLimit": 0,
            "currentUsage": 248
        },
        "contentTerm": null
            "activeDeviceCount": 1,
            "trial": true
    }
}